<!doctype html public "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta name="robot" content="index,follow">
<title>Module gzi - gzip Input Base Module - Forth Foundation Library</title>
</head>
<body>
<h2>gzi - gzip Input Base Module</h2>
<h3>Module Description</h3>
<p>The gzi module implements the gzip inflate algorithm. The module is used
for reading from a gzip file [zif] and, in a future version, stream [zis].
</p>
<h3>Module Words</h3>
<dl>
</dl>
<h4>gzi constants</h4>
<dl>
<dt><a name="word1"><b>gzi.ok</b>	( -- n )</dt>
<dd>Decompression step is okee</dd>
<dt><a name="word2"><b>gzi.done</b>	( -- n )</dt>
<dd>Decompression is done</dd>
<dt><a name="word3"><b>gzi.more</b>	( -- n )</dt>
<dd>Decompression step needs more data</dd>
<dt><a name="word4"><b>gzi.states</b>	( -- n )</dt>
<dd>Decompression step states</dd>
</dl>
<h4>gzi structure</h4>
<dl>
<dt><a name="word5"><b>gzi%</b>	( -- n )</dt>
<dd>Get the required space for a gzi variable</dd>
</dl>
<h4>gzip inflation variable creation, initialisation and destruction</h4>
<dl>
<dt><a name="word6"><b>gzi-init</b>	( u gzi -- )</dt>
<dd>Initialise the gzip inflation variable with an initial output buffer size u</dd>
<dt><a name="word7"><b>gzi-(free)</b>	( gzi -- )</dt>
<dd>Free the internal, private variables from the heap</dd>
<dt><a name="word8"><b>gzi-create</b>	( "&lt;spaces&gt;name" u -- ; -- gzi )</dt>
<dd>Create a named gzip inflation variable in the dictionary with an initial output buffer size u</dd>
<dt><a name="word9"><b>gzi-new</b>	( -- gzi )</dt>
<dd>Create a new gzip inflation variable on the heap</dd>
<dt><a name="word10"><b>gzi-free</b>	( gzi -- )</dt>
<dd>Free the variable from the heap</dd>
</dl>
<h4>Member words</h4>
<dl>
<dt><a name="word11"><b>gzi-lbf@</b>	( gzi -- lbf )</dt>
<dd>Get the output buffer</dd>
</dl>
<h4>Inflate words</h4>
<dl>
<dt><a name="word12"><b>gzi-init-inflate</b>	( gzi -- )</dt>
<dd>Start the inflation of data</dd>
<dt><a name="word13"><b>gzi-inflate</b>	( gzi -- ior )</dt>
<dd>Do the next step in inflating data, return the result code</dd>
<dt><a name="word14"><b>gzi-reduce-output</b>	( gzi -- )</dt>
<dd>Check if the output buffer can be reduced</dd>
<dt><a name="word15"><b>gzi-end-inflate</b>	( gzi -- )</dt>
<dd>Finish the inflation of data</dd>
</dl>
<h4>Inspection</h4>
<dl>
<dt><a name="word16"><b>gzi-dump</b>	( gzi -- )</dt>
<dd>Dump the gzi</dd>
</dl>
<hr>
<div align="center">generated 24-Jul-2010 by <b>ofcfrth-0.10.0</b></div>
</body>
</html>
